add missing props in markdown layout #3588
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `url` props was missing but should there according to [this document](https://docs.astro.build/en/guides/markdown-content/#markdown-layouts). The `file` props was not initially there but is quite useful when you need to resolve file which are relative to the markdown file itself.
🦋 Changeset detectedLatest commit: fe69fed The changes in this PR will be included in the next version bump. This PR includes changesets to release 9 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: astro
matthewp
approved these changes
Jul 12, 2022
|
@charlesvdv sounds good to me. If you want to go ahead and make the corresponding docs change and update the PR here, we can then merge them both. |
|
@matthewp thanks for the review! I just made the necessary changes on the documation. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Fix missing
urlprops in markdown layout which should be there according to this document. Also referenced here 🐛 BUG:content.urlmissing from standalone markdown pages #1603 (comment) (the bug is marked as fixed but it looks like there is a regression from a recent change).Add
fileprops.This is maybe a bit more controversial. When doing
Astro.glob("*.md"), the output contains the file path. I personally use this info to resolve resources which are referenced in as relative path from my frontmatter. For example, given this project:In the
src/pages/blog/random-content/index.md, I have the frontmatter propimg: "./my-blog-img.jpg". When I useAstro.glob, I use the markdown path to resolve the img props to a full path. This would be neat if I could do the same for mardown layout.This might have impact on some projects if some frontmatter props have the key
file.Testing
A test is available to make sure the props are properly generated.
Docs
See withastro/docs#982